Docs Revamp and Astro Upgrade v6 by aggmoulik · Pull Request #1998 · openstatusHQ/openstatus

aggmoulik · 2026-03-21T17:47:13Z

No description provided.

vercel · 2026-03-21T17:47:21Z

@aggmoulik is attempting to deploy a commit to the OpenStatus Team on Vercel.

A member of the Team first needs to authorize it.

cubic-dev-ai

25 issues found across 47 files

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="apps/docs/src/components/override-components/Header.astro">

<violation number="1" location="apps/docs/src/components/override-components/Header.astro:39">
P2: Use `window.addEventListener("scroll", ...)` instead of assigning to `window.onscroll`. Direct property assignment silently overwrites any other scroll handler, which is fragile as the codebase grows.</violation>
</file>

<file name="apps/docs/src/components/SidebarNav.astro">

<violation number="1" location="apps/docs/src/components/SidebarNav.astro:48">
P1: `getFirstHref(item)` can return `null`, which is passed directly as the `href` attribute. This renders a non-functional `<a>` without an `href`. Either filter out items where `href` is `null`, or provide a fallback like `"#"`.</violation>
</file>

<file name="apps/docs/src/components/ImageMod.astro">

<violation number="1" location="apps/docs/src/components/ImageMod.astro:37">
P2: Glob pattern only matches top-level files in `/src/assets/`. Images in subdirectories (e.g. `/src/assets/guides/img.png`) won't resolve, and the component will silently render nothing. Use `**/*` to match at any depth.</violation>
</file>

<file name="apps/docs/astro.config.mjs">

<violation number="1" location="apps/docs/astro.config.mjs:55">
P3: Use `@ts-expect-error` instead of `@ts-ignore`. With `// @ts-check` enabled, `@ts-expect-error` will alert you when the suppressed type error is resolved, preventing stale suppressions.</violation>
</file>

<file name="apps/docs/src/components/Breadcrumb.astro">

<violation number="1" location="apps/docs/src/components/Breadcrumb.astro:13">
P1: `item.href` is computed but never used — breadcrumb items render as plain text instead of links. Preceding items should be wrapped in `<a>` tags so users can navigate back.</violation>
</file>

<file name="apps/docs/package.json">

<violation number="1" location="apps/docs/package.json:21">
P2: All dependency versions in this file were changed from exact pins to caret (`^`) ranges. The rest of the monorepo pins exact versions to ensure reproducible builds and intentional upgrades. Remove the `^` prefixes to align with the project convention (e.g., `"astro": "6.0.8"` instead of `"^6.0.8"`).

(Based on your team's feedback about pinning dependency versions instead of using ranges.) [FEEDBACK_USED]</violation>
</file>

<file name="apps/docs/src/components/override-components/PageFrame.astro">

<violation number="1" location="apps/docs/src/components/override-components/PageFrame.astro:61">
P1: This selector targets a hardcoded Astro scoped-class hash (`.astro-jif73yzw`), which is auto-generated and will change whenever the referenced component's content is modified. Use a `:global()` selector targeting a stable class or data attribute instead, so the rule doesn't silently stop matching after the next rebuild.</violation>
</file>

<file name="apps/docs/src/components/override-components/TwoColumnContent.astro">

<violation number="1" location="apps/docs/src/components/override-components/TwoColumnContent.astro:33">
P1: Content is permanently invisible when JavaScript is unavailable. The `.content-container` starts at `opacity: 0` and only becomes visible via the inline script. Add a `<noscript>` style fallback so the content is still readable without JS:

```html
<noscript><style>.content-container { opacity: 1 !important; }</style></noscript>

Alternatively, set opacity: 1 as the default and let JS add the fade-in transition.

P2: Duplicate `.top-level > li` rule overrides the padding from the earlier rule. The first rule sets `padding-bottom: 1.6rem` and `padding-top: 1rem`, but these are immediately overridden by the second rule's `10px` values. Consolidate into a single rule to avoid confusion about which values actually apply. P2: Duplicate `align-items` property in the `a` rule — `align-items: center` on line 49 is overridden by `align-items: end` on line 58 and has no effect. Remove one of them to clarify the intended alignment. P2: `border-color` on hover has no visible effect because the `border` declaration on `a` is commented out. Either restore the border or remove this dead hover rule. P2: Hardcoded `#A3A3A3` stroke won't adapt to dark mode. Use `currentColor` (inheriting from the text/heading color) or a CSS custom property so the icon remains visible in both light and dark themes. P2: When `className` is not passed, the template literal renders `"theme-switcher undefined"` as the class string. Use a fallback to avoid injecting a literal `"undefined"` class. P1: `themeSwitcher` is guarded with `?.` for `addEventListener` but accessed without a null check inside `DOMContentLoaded`. If the element isn't in the DOM, `themeSwitcher.checked` will throw a TypeError. P2: `CommitMono` is a monospace font, but `primary_type` is `"sans-serif"`. This should be `"monospace"` so the correct generic font family is used as a CSS fallback. P2: The comment says "dark vars on .dark" but `darkVars` are merged into `baseVars` and applied to `:root` alongside everything else — no `.dark` selector exists. If dark-mode overrides are intended, they should be scoped under a `.dark` (or `@media (prefers-color-scheme: dark)`) rule via a separate `addBase` call. P2: Hardcoded `z-index: 200` bypasses the design token system used elsewhere in this file (`var(--sl-z-index-toc)`) and in neighboring components. This can cause z-index stacking issues if the token values change. Also, this line uses spaces instead of tabs, inconsistent with the rest of the file. P2: `href` can be `null` here since `getFirstHref` returns `string | null`. This renders an `` without an `href` attribute — visually it looks clickable (`cursor-pointer`) but won't navigate. Either filter out items with no resolvable href or provide a fallback. P2: The `|| ""` fallback is unreachable — template literals always produce a string, so if `iconPath` is `null`, `img.src` silently becomes `"/null"`. Guard against null before interpolation. P2: The `community`, `help_links`, and `company` sections are structurally identical. Extract them into a loop to reduce duplication and make it easier to add/remove footer sections. P1: This form defaults to `method="GET"`, which will expose the submitted email address in the URL query string. Add `method="POST"` to prevent the email from appearing in browser history, server logs, and referrer headers. P2: The `image` selector doesn't match HTML `` elements — it only matches the SVG `` element. This should almost certainly be `img`. P1: The button's `aria-expanded` is set to `"false"` in the template but never updated by `setExpanded()`, which only sets it on the custom element wrapper (`this`). Screen readers will always report the menu as collapsed. Update the button's attribute as well. P2: Generic font family `sans-serif` must not be quoted. Quoted `"sans-serif"` is treated as a literal named font lookup, not a generic family fallback. If `calsans` fails to load, the browser won't fall back to the system sans-serif. P1: Monospace font `CommitMono` falls back to quoted `'sans-serif'` instead of unquoted `monospace`. If the font fails to load, code will render proportionally. Use the `monospace` generic family (unquoted) as the fallback. ```

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

apps/docs/src/components/SidebarNav.astro

apps/docs/src/components/Breadcrumb.astro

apps/docs/src/components/override-components/PageFrame.astro

cubic-dev-ai · 2026-03-21T17:51:28Z

apps/docs/src/components/override-components/TwoColumnContent.astro

+    .content-container {
+      width: 100%;
+      overflow: hidden;
+      opacity: 0;


P1: Content is permanently invisible when JavaScript is unavailable. The .content-container starts at opacity: 0 and only becomes visible via the inline script. Add a <noscript> style fallback so the content is still readable without JS:

<noscript><style>.content-container { opacity: 1 !important; }</style></noscript>

Alternatively, set opacity: 1 as the default and let JS add the fade-in transition.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At apps/docs/src/components/override-components/TwoColumnContent.astro, line 33: <comment>Content is permanently invisible when JavaScript is unavailable. The `.content-container` starts at `opacity: 0` and only becomes visible via the inline script. Add a `<noscript>` style fallback so the content is still readable without JS: ```html <noscript><style>.content-container { opacity: 1 !important; }</style></noscript>

Alternatively, set opacity: 1 as the default and let JS add the fade-in transition.
@@ -0,0 +1,87 @@ + .content-container { + width: 100%; + overflow: hidden; + opacity: 0; + transition: opacity 0.3s ease-in-out; + } ```

cubic-dev-ai · 2026-03-21T17:51:28Z

apps/docs/src/components/override-components/ThemeSwitch.astro

+  });
+
+  document.addEventListener("DOMContentLoaded", () => {
+    const savedTheme = localStorage.getItem("starlight-theme");


P1: themeSwitcher is guarded with ?. for addEventListener but accessed without a null check inside DOMContentLoaded. If the element isn't in the DOM, themeSwitcher.checked will throw a TypeError.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At apps/docs/src/components/override-components/ThemeSwitch.astro, line 91: <comment>`themeSwitcher` is guarded with `?.` for `addEventListener` but accessed without a null check inside `DOMContentLoaded`. If the element isn't in the DOM, `themeSwitcher.checked` will throw a TypeError.</comment> <file context> @@ -0,0 +1,100 @@ + }); + + document.addEventListener("DOMContentLoaded", () => { + const savedTheme = localStorage.getItem("starlight-theme"); + if (savedTheme === "light") { + themeSwitcher.checked = false; </file context>

apps/docs/src/components/override-components/Hero.astro

apps/docs/src/components/override-components/Footer.astro

apps/docs/src/styles/navigation.css

apps/docs/src/styles/global.css

cubic-dev-ai · 2026-03-21T17:51:29Z

apps/docs/astro.config.mjs

+        dark: logo_darkmode,
+        alt: "OpenStatus Logo",
+      },
+      // @ts-ignore


P3: Use @ts-expect-error instead of @ts-ignore. With // @ts-check enabled, @ts-expect-error will alert you when the suppressed type error is resolved, preventing stale suppressions.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At apps/docs/astro.config.mjs, line 55: <comment>Use `@ts-expect-error` instead of `@ts-ignore`. With `// @ts-check` enabled, `@ts-expect-error` will alert you when the suppressed type error is resolved, preventing stale suppressions.</comment> <file context> @@ -28,217 +45,34 @@ export default defineConfig({ + dark: logo_darkmode, + alt: "OpenStatus Logo", + }, + // @ts-ignore + social: social.main || [], + sidebar: sidebar.main || [], </file context>

Suggested change

// @ts-ignore

// @ts-expect-error - social config shape may differ from Starlight's expected type

cubic-dev-ai

1 issue found across 8 files (changes from recent commits).

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="apps/docs/astro.config.mjs">

<violation number="1" location="apps/docs/astro.config.mjs:1">
P2: `// @ts-check` is no longer the first line of the file, so TypeScript will silently ignore it and skip type checking. Move the import below the directive to restore type checking.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

apps/docs/astro.config.mjs

cubic-dev-ai

1 issue found across 2 files (changes from recent commits).

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="apps/docs/src/components/override-components/Header.astro">

<violation number="1" location="apps/docs/src/components/override-components/Header.astro:35">
P2: `as any` on the icon name bypasses Starlight's `Icon` type checking, hiding invalid icon names until runtime. Consider typing the JSON values against Starlight's supported icon names (e.g., importing the icon name type) or at minimum using a more specific assertion so build-time validation catches typos.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

apps/docs/src/components/override-components/Header.astro

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

cubic-dev-ai bot reviewed Mar 21, 2026

View reviewed changes

apps/docs/astro.config.mjs Show resolved Hide resolved

cubic-dev-ai bot reviewed Mar 26, 2026

View reviewed changes

apps/docs/src/components/override-components/Header.astro Show resolved Hide resolved

aggmoulik force-pushed the feature/revamp-docs branch from d5ca2cc to 69b6020 Compare March 26, 2026 18:54

aggmoulik added 8 commits March 28, 2026 02:20

Revamp Openstatus Docs

2f01273

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

Updated Sitetitle and css

58cc346

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

Update package.json exact version

e83cc0f

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

Formatted code

cb05525

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

Update sidebarnav and padding

fda0152

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

Update navigation for socials

8943dd2

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

Fixed a AI code review

4778eb5

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

Updated format

91d32c0

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

aggmoulik force-pushed the feature/revamp-docs branch from e114392 to 91d32c0 Compare March 27, 2026 20:52

Added wrangler cli setup for deployment

6e24902

Signed-off-by: Moulik Aggarwal <qwertymoulik@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Docs Revamp and Astro Upgrade v6#1998

Docs Revamp and Astro Upgrade v6#1998
aggmoulik wants to merge 9 commits intoopenstatusHQ:mainfrom
aggmoulik:feature/revamp-docs

aggmoulik commented Mar 21, 2026

Uh oh!

vercel bot commented Mar 21, 2026

Uh oh!

cubic-dev-ai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cubic-dev-ai bot Mar 21, 2026 •

edited

Loading

Uh oh!

cubic-dev-ai bot Mar 21, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cubic-dev-ai bot Mar 21, 2026 •

edited

Loading

Uh oh!

cubic-dev-ai bot left a comment

Uh oh!

Uh oh!

cubic-dev-ai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	// @ts-ignore
	// @ts-expect-error - social config shape may differ from Starlight's expected type

Uh oh!

Conversation

aggmoulik commented Mar 21, 2026

Uh oh!

vercel bot commented Mar 21, 2026

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cubic-dev-ai bot Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cubic-dev-ai bot Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

cubic-dev-ai bot Mar 21, 2026 •

edited

Loading

cubic-dev-ai bot Mar 21, 2026 •

edited

Loading

cubic-dev-ai bot Mar 21, 2026 •

edited

Loading